Skip to main content

Get Event Details

Route

/v2/event-details

Description

Retrieve detailed information about specific events using event IDs. Events represent data movement activities captured by Cyberhaven sensors.

Method

POST (Recommended) | GET | GET with path parameters

Inputs

ParameterTypeRequiredDescription
idsarray[string]YesArray of event IDs to retrieve (max 100)
include_contentbooleanNoInclude content analysis results in response

Request Methods

POST (Recommended)

{
"ids": ["event-123", "event-456"],
"include_content": true
}

GET with Query Parameters

GET /v2/event-details?ids=event-123&ids=event-456&include_content=true

GET with Path Parameters

GET /v2/event-details/event-123,event-456

Output

FieldTypeDescription
typestringAlways "events"
sizeintegerNumber of events returned
resourcesarray[Event]Array of event objects
errorsarray[Error]Any errors encountered

Event Object Structure

FieldTypeDescription
idstringUnique event identifier
timestampstringEvent timestamp (ISO 8601)
actionActionAction details and context
userEventUserUser who performed the action
sourceLocationSource location of the data
destinationLocationDestination location of the data

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"type": "events",
"size": 2,
"resources": [
{
"id": "event-123",
"timestamp": "2024-01-15T10:30:00Z",
"action": {
"kind": "upload",
"blocked": false,
"data_size": 1024
},
"user": {
"id": "user-456",
"local_username": "john.doe"
},
"source": {
"file": {
"name": "document.pdf",
"size": 1024
}
},
"destination": {
"web": {
"domain": "drive.google.com"
}
}
}
],
"errors": []
}